<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Initialization Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__usbfs__dev__hal__functions__common.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Initialization Functions<div class="ingroups"><a class="el" href="group__group__usbfs__dev__drv.html">USBFS        (USB Full-Speed Device)</a> &raquo; <a class="el" href="group__group__usbfs__dev__drv__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The Initialization functions provide an API to begin the USBFS driver operation (configure and enable) and to stop operation (disable and de-initialize). </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadd8371859c363f83d16376550f19d90f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__usbfs__dev__drv__enums.html#gace2573b482baf5a2a0f796b72cc244ac">cy_en_usbfs_dev_drv_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gadd8371859c363f83d16376550f19d90f">Cy_USBFS_Dev_Drv_Init</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__config__t.html">cy_stc_usbfs_dev_drv_config_t</a> const *config, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:gadd8371859c363f83d16376550f19d90f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the USBFS in device mode.  <a href="#gadd8371859c363f83d16376550f19d90f">More...</a><br /></td></tr>
<tr class="separator:gadd8371859c363f83d16376550f19d90f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafc1931448521bc57d22c602e451d978a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gafc1931448521bc57d22c602e451d978a">Cy_USBFS_Dev_Drv_DeInit</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:gafc1931448521bc57d22c602e451d978a"><td class="mdescLeft">&#160;</td><td class="mdescRight">De-initializes the USBFS Device hardware (returns the register values to default) and removes all registered callbacks.  <a href="#gafc1931448521bc57d22c602e451d978a">More...</a><br /></td></tr>
<tr class="separator:gafc1931448521bc57d22c602e451d978a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae27b769588f6bba57b4ce62276b19c99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gae27b769588f6bba57b4ce62276b19c99">Cy_USBFS_Dev_Drv_Enable</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> const *context)</td></tr>
<tr class="memdesc:gae27b769588f6bba57b4ce62276b19c99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the USBFS Device operation.  <a href="#gae27b769588f6bba57b4ce62276b19c99">More...</a><br /></td></tr>
<tr class="separator:gae27b769588f6bba57b4ce62276b19c99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9f5b81775dcb9b664ac8bd46f5b89a8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gab9f5b81775dcb9b664ac8bd46f5b89a8">Cy_USBFS_Dev_Drv_Disable</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:gab9f5b81775dcb9b664ac8bd46f5b89a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the USBFS Device operation.  <a href="#gab9f5b81775dcb9b664ac8bd46f5b89a8">More...</a><br /></td></tr>
<tr class="separator:gab9f5b81775dcb9b664ac8bd46f5b89a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadb382fffcc696975a198f11d1d96c9c2"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gadb382fffcc696975a198f11d1d96c9c2">Cy_USBFS_Dev_Drv_SetAddress</a> (USBFS_Type *base, uint8_t address, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:gadb382fffcc696975a198f11d1d96c9c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Posts a request to set the device address after the completion status stage of the control transfer.  <a href="#gadb382fffcc696975a198f11d1d96c9c2">More...</a><br /></td></tr>
<tr class="separator:gadb382fffcc696975a198f11d1d96c9c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1c88ad68e03d28223253f9322ff3ab26"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#ga1c88ad68e03d28223253f9322ff3ab26">Cy_USBFS_Dev_Drv_SetDeviceAddress</a> (USBFS_Type *base, uint8_t address)</td></tr>
<tr class="memdesc:ga1c88ad68e03d28223253f9322ff3ab26"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the device address (writes the address directly into the register).  <a href="#ga1c88ad68e03d28223253f9322ff3ab26">More...</a><br /></td></tr>
<tr class="separator:ga1c88ad68e03d28223253f9322ff3ab26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga69d1db60ce95bfb7d6d750451a0e2398"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#ga69d1db60ce95bfb7d6d750451a0e2398">Cy_USBFS_Dev_Drv_GetDeviceAddress</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga69d1db60ce95bfb7d6d750451a0e2398"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the device address (reads the address directly from the register).  <a href="#ga69d1db60ce95bfb7d6d750451a0e2398">More...</a><br /></td></tr>
<tr class="separator:ga69d1db60ce95bfb7d6d750451a0e2398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d8c31d0057af5aa805be1b0784b59e2"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#ga7d8c31d0057af5aa805be1b0784b59e2">Cy_USBFS_Dev_Drv_SetDevContext</a> (USBFS_Type const *base, void *devContext, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga7d8c31d0057af5aa805be1b0784b59e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a pointer to the USB Device context in the driver context.  <a href="#ga7d8c31d0057af5aa805be1b0784b59e2">More...</a><br /></td></tr>
<tr class="separator:ga7d8c31d0057af5aa805be1b0784b59e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d4e3c9891562a422efa320a366dd64b"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#ga4d4e3c9891562a422efa320a366dd64b">Cy_USBFS_Dev_Drv_GetDevContext</a> (USBFS_Type const *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga4d4e3c9891562a422efa320a366dd64b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the USB Device context.  <a href="#ga4d4e3c9891562a422efa320a366dd64b">More...</a><br /></td></tr>
<tr class="separator:ga4d4e3c9891562a422efa320a366dd64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadcd2b88937a1cb573838a3f83655d695"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#gadcd2b88937a1cb573838a3f83655d695">Cy_USBFS_Dev_Drv_ConfigDevice</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:gadcd2b88937a1cb573838a3f83655d695"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the basic device configuration (clears previous configuration).  <a href="#gadcd2b88937a1cb573838a3f83655d695">More...</a><br /></td></tr>
<tr class="separator:gadcd2b88937a1cb573838a3f83655d695"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20cd68fc7ca73e6c333e3c59fd636a22"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__hal__functions__common.html#ga20cd68fc7ca73e6c333e3c59fd636a22">Cy_USBFS_Dev_Drv_UnConfigureDevice</a> (USBFS_Type *base, <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *context)</td></tr>
<tr class="memdesc:ga20cd68fc7ca73e6c333e3c59fd636a22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears device configuration.  <a href="#ga20cd68fc7ca73e6c333e3c59fd636a22">More...</a><br /></td></tr>
<tr class="separator:ga20cd68fc7ca73e6c333e3c59fd636a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gadd8371859c363f83d16376550f19d90f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadd8371859c363f83d16376550f19d90f">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__usbfs__dev__drv__enums.html#gace2573b482baf5a2a0f796b72cc244ac">cy_en_usbfs_dev_drv_status_t</a> Cy_USBFS_Dev_Drv_Init </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__config__t.html">cy_stc_usbfs_dev_drv_config_t</a> const *&#160;</td>
          <td class="paramname"><em>config</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the USBFS in device mode. </p>
<p>If DMAs are used, initialize the DMAs.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">config</td><td>The pointer to the configuration structure <a class="el" href="structcy__stc__usbfs__dev__drv__config__t.html">cy_stc_usbfs_dev_drv_config_t</a>.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The status code of the function execution <a class="el" href="group__group__usbfs__dev__drv__enums.html#gace2573b482baf5a2a0f796b72cc244ac">cy_en_usbfs_dev_drv_status_t</a>. </dd></dl>

</div>
</div>
<a id="gafc1931448521bc57d22c602e451d978a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc1931448521bc57d22c602e451d978a">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_DeInit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_DeInit </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>De-initializes the USBFS Device hardware (returns the register values to default) and removes all registered callbacks. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gae27b769588f6bba57b4ce62276b19c99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae27b769588f6bba57b4ce62276b19c99">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_Enable </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> const *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the USBFS Device operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab9f5b81775dcb9b664ac8bd46f5b89a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab9f5b81775dcb9b664ac8bd46f5b89a8">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_Disable </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the USBFS Device operation. </p>
<p>If DMAs are used, disables the DMAs.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gadb382fffcc696975a198f11d1d96c9c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb382fffcc696975a198f11d1d96c9c2">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_SetAddress()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_SetAddress </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>address</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Posts a request to set the device address after the completion status stage of the control transfer. </p>
<p>This function must be used if a higher level requests to set an address before the status stage of the control transfer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">address</td><td>The device address.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga1c88ad68e03d28223253f9322ff3ab26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1c88ad68e03d28223253f9322ff3ab26">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_SetDeviceAddress()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_SetDeviceAddress </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>address</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the device address (writes the address directly into the register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">address</td><td>Device address. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga69d1db60ce95bfb7d6d750451a0e2398"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga69d1db60ce95bfb7d6d750451a0e2398">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetDeviceAddress()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_GetDeviceAddress </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the device address (reads the address directly from the register). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The device address. The device address is assigned by the Host during device enumeration. Zero means that the device address is not assigned. </dd></dl>

</div>
</div>
<a id="ga7d8c31d0057af5aa805be1b0784b59e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d8c31d0057af5aa805be1b0784b59e2">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_SetDevContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_SetDevContext </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>devContext</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stores a pointer to the USB Device context in the driver context. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance</td></tr>
    <tr><td class="paramname">devContext</td><td>The pointer to the USB Device context structure.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This function is intended for the USB Device middleware operation. </dd></dl>

</div>
</div>
<a id="ga4d4e3c9891562a422efa320a366dd64b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d4e3c9891562a422efa320a366dd64b">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_GetDevContext()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void * Cy_USBFS_Dev_Drv_GetDevContext </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a pointer to the USB Device context. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The pointer to the USB Device context.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is intended for the USB Device middleware operation. </dd></dl>

</div>
</div>
<a id="gadcd2b88937a1cb573838a3f83655d695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadcd2b88937a1cb573838a3f83655d695">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_ConfigDevice()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_ConfigDevice </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the basic device configuration (clears previous configuration). </p>
<p>Call this function after the endpoints were configured to complete the device configuration.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga20cd68fc7ca73e6c333e3c59fd636a22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20cd68fc7ca73e6c333e3c59fd636a22">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_UnConfigureDevice()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_USBFS_Dev_Drv_UnConfigureDevice </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> *&#160;</td>
          <td class="paramname"><em>context</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears device configuration. </p>
<p>Call this function before setting a configuration or a configuration failure to set the configuration into the default state. Alternately, call <a class="el" href="group__group__usbfs__dev__hal__functions__endpoint__config.html#ga732e3eb9471c9587f3305eaacb4cd1a2">Cy_USBFS_Dev_Drv_RemoveEndpoint</a> for each active endpoint.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">context</td><td>The pointer to the context structure <a class="el" href="structcy__stc__usbfs__dev__drv__context__t.html">cy_stc_usbfs_dev_drv_context_t</a> allocated by the user. The structure is used during the USBFS Device operation for internal configuration and data retention. The user must not modify anything in this structure. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
